﻿//-----------------------------------------------------------------------
// <copyright file="IMessagesRepository.cs" company="OOHM PROCESSAMENTO DE DADOS LTDA.">
//     Microsoft Public License (MS-PL) This license governs use of the accompanying
//     software. If you use the software, you accept this license. If you do not
//     accept the license, do not use the software. 1. Definitions The terms "reproduce,"
//     "reproduction," "derivative works," and "distribution" have the same meaning
//     here as under U.S. copyright law. A "contribution" is the original software,
//     or any additions or changes to the software. A "contributor" is any person
//     that distributes its contribution under this license. "Licensed patents"
//     are a contributor's patent claims that read directly on its contribution.
//     2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license,
//     including the license conditions and limitations in section 3, each contributor
//     grants you a non-exclusive, worldwide, royalty-free copyright license to
//     reproduce its contribution, prepare derivative works of its contribution,
//     and distribute its contribution or any derivative works that you create.
//     (B) Patent Grant- Subject to the terms of this license, including the license
//     conditions and limitations in section 3, each contributor grants you a non-exclusive,
//     worldwide, royalty-free license under its licensed patents to make, have
//     made, use, sell, offer for sale, import, and/or otherwise dispose of its
//     contribution in the software or derivative works of the contribution in
//     the software. 3. Conditions and Limitations (A) No Trademark License- This
//     license does not grant you rights to use any contributors' name, logo, or
//     trademarks. (B) If you bring a patent claim against any contributor over
//     patents that you claim are infringed by the software, your patent license
//     from such contributor to the software ends automatically. (C) If you distribute
//     any portion of the software, you must retain all copyright, patent, trademark,
//     and attribution notices that are present in the software. (D) If you distribute
//     any portion of the software in source code form, you may do so only under
//     this license by including a complete copy of this license with your distribution.
//     If you distribute any portion of the software in compiled or object code
//     form, you may only do so under a license that complies with this license.
//     (E) The software is licensed "as-is." You bear the risk of using it. The
//     contributors give no express warranties, guarantees or conditions. You may
//     have additional consumer rights under your local laws which this license
//     cannot change. To the extent permitted under your local laws, the contributors
//     exclude the implied warranties of merchantability, fitness for a particular
// </copyright>
//-----------------------------------------------------------------------
namespace AbstractSaaSTemplate.Domain.Repositories{    using System;
    using System.Collections.Generic;
    using AbstractSaaSTemplate.Domain.Models.Entities;

    /// <summary>
    /// Describes the contract for the 'MessageScheduler' repository.
    /// </summary>
    public interface IMessagesRepository : IRepository
    {
        /// <summary>
        /// Gets a number of messages to dispatch and mark them
        /// as invisible for a period of time, to avoid two instances
        /// working on the same messages when scaling up the number of servers.
        /// </summary>
        /// <param name="numberOfMessages">Defines the number of messages that should be retrieved.</param>
        /// <param name="keepInvisibleForSeconds">Keeps all messages consumed by this method for the number of seconds defined, avoiding that this message is consumed by another queue.</param>
        /// <returns>Returns a list of Message to be dispatched.</returns>
        IEnumerable<Message> GetMessagesReadyToDispatch(int numberOfMessages, int keepInvisibleForSeconds);
        
        /// <summary>
        /// Schedules the dispatch of a message.
        /// </summary>
        /// <param name="entity">The message that will be scheduled for dispatch.</param>
        void ScheduleMessageForDispatch(Message entity);

        /// <summary>
        /// Schedules the dispatch of a message.
        /// </summary>
        /// <param name="entity">The message that will be scheduled for dispatch.</param>
        /// <param name="doNotSendBefore">Date from which this message can be sent.</param>
        void ScheduleMessageForDispatch(Message entity, DateTime doNotSendBefore);

        /// <summary>
        /// Marks the message as dispatched.
        /// </summary>
        /// <param name="id">The id of the message.</param>
        void MarkMessageAsDispatched(Guid id);
    }
}


